<!DOCTYPE HTML><html><head><title>SLL Service Catalogue GUI support service API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/kevinrenskers/raml2html 1.6.0"><link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="http://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript">
        $(document).ready(function() {
            $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
                hljs.highlightBlock(block);
            });

            $('[data-toggle]').click(function() {
                var selector = $(this).data('target') + ' pre code';
                $(selector).each(function(i, block) {
                    hljs.highlightBlock(block);
                });
            });
            
            
            // open modal on hashes like #_action_get
            $(window).bind('hashchange', function(e) {
                var anchor_id = document.location.hash.substr(1); //strip #
                var element = $('#' + anchor_id);

                // do we have such element + is it a modal?  --> show it
                if (element.length && element.hasClass('modal')) {
                    element.modal('show');
                }
            });

            // execute hashchange on first page load
            $(window).trigger('hashchange');
            
            // remove url fragment on modal hide
            $('.modal').on('hidden.bs.modal', function() {
                if(history && history.replaceState) { 
                    history.replaceState({}, '', '#');
                }
            });
        });
    </script><style>
        .hljs {
            background: transparent;
        }
        .parent {
            color: #999;
        }
        .list-group-item > .badge {
            float: none;
            margin-right: 6px;
        }
        .panel-title > .methods {
            float: right;
        }
        .badge {
            border-radius: 0;
            text-transform: uppercase;
            width: 70px;
            font-weight: normal;
            color: #f3f3f6;
            line-height: normal;
        }
        .badge_get {
            background-color: #63a8e2;
        }
        .badge_post {
            background-color: #6cbd7d;
        }
        .badge_put {
            background-color: #22bac4;
        }
        .badge_delete {
            background-color: #d26460;
        }
        .badge_patch {
            background-color: #ccc444;
        }
        .list-group, .panel-group {
            margin-bottom: 0;
        }
        .panel-group .panel+.panel-white {
            margin-top: 0;
        }
        .panel-group .panel-white {
            border-bottom: 1px solid #F5F5F5;
            border-radius: 0;
        }
        .panel-white:last-child {
            border-bottom-color: white;
            -webkit-box-shadow: none;
            box-shadow: none;
        }
        .panel-white .panel-heading {
            background: white;
        }
        .tab-pane ul {
            padding-left: 2em;
        }
        .tab-pane h2 {
            font-size: 1.2em;
            padding-bottom: 4px;
            border-bottom: 1px solid #ddd;
        }
        .tab-pane h3 {
            font-size: 1.1em;
        }
        .tab-content {
            border-left: 1px solid #ddd;
            border-right: 1px solid #ddd;
            border-bottom: 1px solid #ddd;
            padding: 10px;
        }
        #sidebar {
            margin-top: 30px;
            padding-right: 5px;
            overflow: auto;
            height: 90%;
        }
        .top-resource-description {
            border-bottom: 1px solid #ddd;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description {
            border-bottom: 1px solid #fcfcfc;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description p:last-child {
            margin: 0;
        }
        .list-group .badge {
            float: left;
        }
        .method_description {
            margin-left: 85px;
        }
        .method_description p:last-child {
            margin: 0;
        }
        .list-group-item {
            cursor: pointer;
        }
        .list-group-item:hover {
            background-color: #f5f5f5;
        }
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>SLL Service Catalogue GUI support service API documentation <small>version 1.0</small></h1><p>http://localhost:8080/gui</p><h3 id="General-API-information"><a href="#General-API-information">General API information</a></h3><p>TODO! Description of the GUI Service Functions</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_aggregated" class="panel-title">AggregatedService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Aggredated service for fetching information from any of the underlying base information services</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_test"><span class="parent">/aggregated</span>/test</a> <span class="methods"><a href="#_aggregated_test_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__aggregated_test" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_test_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Some sort of test service that just throws an exception. Unknown if it is currently in use.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_test_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/aggregated</span>/test</h4></div><div class="modal-body"><div class="alert alert-info"><p>Some sort of test service that just throws an exception. Unknown if it is currently in use.</p></div><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_capacity__hsaID_"><span class="parent">/aggregated</span>/capacity/{hsaID}</a> <span class="methods"><a href="#_aggregated_capacity__hsaID__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__aggregated_capacity__hsaID_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_capacity__hsaID__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Lists all capacity information for a specific care unit HSA Id.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_capacity__hsaID__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/aggregated</span>/capacity/{hsaID}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Lists all capacity information for a specific care unit HSA Id.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_aggregated_capacity__hsaID__get_request" data-toggle="tab">Request</a></li><li><a href="#_aggregated_capacity__hsaID__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_aggregated_capacity__hsaID__get_request"><h3>URI Parameters</h3><ul><li><strong>hsaID</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_aggregated_capacity__hsaID__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a list of products per care unit",
    "items": { "$ref": "productsByUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "hsaID": "SE2321000016-3TNL",
    "name": "Namn",
    "products": [
      {
        "id": "SE2321000016-1HF3",
        "name": "40",
        "capacity": [
          {
            "codeSystem": "oid.sll.vantetider",
            "code": "2",
            "displayName": "Namnet",
            "value": "4",
            "validTo": 1425410281000
          },
          {
            "codeSystem": "oid.sll.vantetider",
            "code": "2",
            "displayName": "Namnet",
            "value": "4",
            "validTo": 1425410281000
          }
        ]
      }
    ]
  }
]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_capacity_byunitids"><span class="parent">/aggregated</span>/capacity/byunitids</a> <span class="methods"><a href="#_aggregated_capacity_byunitids_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__aggregated_capacity_byunitids" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_capacity_byunitids_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Lists all the capacity information for the provided list of unit id:s</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_capacity_byunitids_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/aggregated</span>/capacity/byunitids</h4></div><div class="modal-body"><div class="alert alert-info"><p>Lists all the capacity information for the provided list of unit id:s</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_aggregated_capacity_byunitids_post_request" data-toggle="tab">Request</a></li><li><a href="#_aggregated_capacity_byunitids_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_aggregated_capacity_byunitids_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of UnitIds",
  "properties": {
    "units": { 
      "type": "array",
      "items": { "$ref": "unit" }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "units" :
    [
      {"unitId": "SE2321000016-4ZRK"},
      {"unitId": "SE2321000016-G82R"}
    ]
}
</code></pre></div><div class="tab-pane" id="_aggregated_capacity_byunitids_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a list of products per care unit",
    "items": { "$ref": "productsByUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "hsaID": "SE2321000016-3TNL",
    "name": "Namn",
    "products": [
      {
        "id": "SE2321000016-1HF3",
        "name": "40",
        "capacity": [
          {
            "codeSystem": "oid.sll.vantetider",
            "code": "2",
            "displayName": "Namnet",
            "value": "4",
            "validTo": 1425410281000
          },
          {
            "codeSystem": "oid.sll.vantetider",
            "code": "2",
            "displayName": "Namnet",
            "value": "4",
            "validTo": 1425410281000
          }
        ]
      }
    ]
  }
]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_units"><span class="parent">/aggregated</span>/units</a> <span class="methods"><a href="#_aggregated_units_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__aggregated_units" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_units_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>TODO - Ta bort!</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_units_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/aggregated</span>/units</h4></div><div class="modal-body"><div class="alert alert-info"><p>TODO - Ta bort!</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_aggregated_units_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_aggregated_units_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested unit information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a list of units",
    "items": { "$ref": "unit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "creationTime": 1393305699000,
    "productReferences": [
      {
        "capacities": [],
        "comment": null,
        "contractedPrice": null,
        "contractedProduct": false,
        "product": {
            "codes": [],
            "creationTime": null,
            "description": null,
            "displayName": null,
            "name": "5",
            "status": null,
            "updateTime": null,
            "updatedByHsaid": null
        }
      }
    ],
    "regionalUnitId": "SE2321000016-4ZRK",
    "relativeDistinguishedName": null,
    "unitId": "SE2321000016-4ZRK",
    "updateTime": 1425911569000
  }
]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_unit__hsaId_"><span class="parent">/aggregated</span>/unit/{hsaId}</a> <span class="methods"><a href="#_aggregated_unit__hsaId__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__aggregated_unit__hsaId_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_unit__hsaId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads information for a specific Care Unit HSA Id</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_unit__hsaId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/aggregated</span>/unit/{hsaId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads information for a specific Care Unit HSA Id</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_aggregated_unit__hsaId__get_request" data-toggle="tab">Request</a></li><li><a href="#_aggregated_unit__hsaId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_aggregated_unit__hsaId__get_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_aggregated_unit__hsaId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested unit information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a list of units",
    "items": { "$ref": "unit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "creationTime": 1393305699000,
    "productReferences": [
      {
        "capacities": [],
        "comment": null,
        "contractedPrice": null,
        "contractedProduct": false,
        "product": {
            "codes": [],
            "creationTime": null,
            "description": null,
            "displayName": null,
            "name": "5",
            "status": null,
            "updateTime": null,
            "updatedByHsaid": null
        }
      }
    ],
    "regionalUnitId": "SE2321000016-4ZRK",
    "relativeDistinguishedName": null,
    "unitId": "SE2321000016-4ZRK",
    "updateTime": 1425911569000
  }
]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__aggregated_idmap"><span class="parent">/aggregated</span>/idmap</a> <span class="methods"><a href="#_aggregated_idmap_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__aggregated_idmap" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_aggregated_idmap_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads the entire current Id map</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_aggregated_idmap_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/aggregated</span>/idmap</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads the entire current Id map</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_aggregated_idmap_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_aggregated_idmap_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested Id map was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of id mappings",
  "items": { "$ref": "idmap" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "hsaId": "SE2321000016-4ZRK",
    "ekId": "213F3343342",
    "hsaRelativeDistinguishedName": "",
    "vmId": "34234",
    "vmCareGiverPartId": "SE2321000016-4Y9X",
    "vmCareGiverName": "SLSO",
    "vmCareGiverPartName": "SL",
    "kombika": "2351223L01",
    "sklId": "VG14141121",
    "allowExport": false,
    "allowImport": false
  }
]
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_monitor" class="panel-title">MonitorService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Handles monitoring of service status</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__monitor"><span class="parent"></span>/monitor</a> <span class="methods"><a href="#_monitor_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__monitor" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_monitor_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads the current monitor status</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_monitor_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/monitor</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads the current monitor status</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_monitor_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_monitor_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested Id map was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "The current monitor info",
    "properties": {
        "vmImportFileTimeStamp": { "type": "string", "required": false },
        "vmImportTimeStamp": { "type": "string", "required": false },
        "vmImportNumOffers": { "type": "string", "required": false },
        "vmImportNumCapacities": { "type": "string", "required": false },
        "vmImportNumIdmap":  { "type": "string", "required": false },
        "vmImportNumProducts":  { "type": "string", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "vmImportFileTimeStamp": "Feb 23, 2014 8:00:01 PM",
  "vmImportNumCapacities": "4893",
  "vmImportNumIdmap": "416",
  "vmImportNumOffers": "488",
  "vmImportNumProducts": "166",
  "vmImportTimeStamp": "20140224072356"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_roles" class="panel-title">RolesService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Handles information of different user roles</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__roles"><span class="parent"></span>/roles</a> <span class="methods"><a href="#_roles_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__roles" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_roles_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads the current availible user roles.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_roles_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/roles</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads the current availible user roles.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_roles_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_roles_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested Role was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a list of Role infos",
    "items": { "$ref": "roleInfo" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {"role":"SUPERADMIN"},
  {"role":"CAREUNITADMIN"},
  {"role":"CAPACITYADMIN"}
]
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_users" class="panel-title">UsersService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Handles information of different users</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users"><span class="parent"></span>/users</a> <span class="methods"><a href="#_users_get"><span class="badge badge_get">get</span></a> <a href="#_users_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__users" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all users. NOTE - careUnit is not returned</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_users_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new User</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/users</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all users. NOTE - careUnit is not returned</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested User was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of Users",
  "items": { "$ref": "user" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "careUnits": [],
    "createdByHsaId": "",
    "creationTime": 1391636105000,
    "email": "",
    "hsaId": "super",
    "lastLogin": 1428666138000,
    "realname": "super",
    "role": "SUPERADMIN",
    "sourceSystemHsaId": "",
    "status": "ACTIVE",
    "updatedTime": 1391636105000
  },
  {
    "careUnits": [],
    "createdByHsaId": "",
    "creationTime": 1399452714000,
    "email": "ca@sll.se",
    "hsaId": "ca",
    "lastLogin": null,
    "realname": "Capacity Admin",
    "role": "CAPACITYADMIN",
    "sourceSystemHsaId": "",
    "status": "ACTIVE",
    "updatedTime": 1399452714000
  }
]
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/users</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new User</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users_post_request" data-toggle="tab">Request</a></li><li><a href="#_users_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A User creation or update request",
    "properties": {
        "status": { "type": "string", "required": true },
        "hsaId": { "type": "string", "required": true, "minLength": 1 },
        "realname": { "type": "string", "required": true },
        "email": { "type": "string", "required": true, "minLength": 1 },
        "hsaID": { "type": "string", "required": false },
        "password": { "type": "string", "minLength": 8 },
        "role": { "type": "string", "required": false },
        "careUnitID": { "$ref": "careUnitReferenceList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "status": "OPEN",
  "hsaId": "SE2321000016-FHR3",
  "realname": "Bosse Bäckström",
  "email": "bosse.backstrom@bockling.nu",
  "hsaID": "SE2321000016-FHR3",
  "password": "********",
  "role": "Vaktmästare",
  "careUnitID":
  [
    {
      "hsaId": "SE2321000016-45FD",
      "displayName": "Enhet X"
    }
  ]
}
</code></pre></div><div class="tab-pane" id="_users_post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested User was successfully created and is returned in the body</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A single User",
    "properties": {
        "status": { "type": "string", "required": false },
        "role": { "type": "string", "required": false },
        "createdByHsaId": { "type": "string", "required": false },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "realname": { "type": "string", "required": false },
        "email": { "type": "string", "required": false },
        "hsaId": { "type": "string", "required": false },
        "creationTime": { "type": "string", "format": "date-time", "required": false },
        "updatedTime": { "type": "string", "format": "date-time", "required": false },
        "lastLogin": { "type": "string", "format": "date-time", "required": false },
        "careUnits": { "$ref": "careUnitReferenceList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "careUnits": [],
  "createdByHsaId": "",
  "creationTime": 1391636105000,
  "email": "",
  "hsaId": "super",
  "lastLogin": 1428666138000,
  "realname": "super",
  "role": "SUPERADMIN",
  "sourceSystemHsaId": "",
  "status": "ACTIVE",
  "updatedTime": 1391636105000
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users__hsaId_"><span class="parent">/users</span>/{hsaId}</a> <span class="methods"><a href="#_users__hsaId__get"><span class="badge badge_get">get</span></a> <a href="#_users__hsaId__put"><span class="badge badge_put">put</span></a> <a href="#_users__hsaId__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel__users__hsaId_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users__hsaId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a specific User</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_users__hsaId__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update the information for a specific user.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_users__hsaId__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete an offer</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users__hsaId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/users</span>/{hsaId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a specific User</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users__hsaId__get_request" data-toggle="tab">Request</a></li><li><a href="#_users__hsaId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users__hsaId__get_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the User</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_users__hsaId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested User was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A single User",
    "properties": {
        "status": { "type": "string", "required": false },
        "role": { "type": "string", "required": false },
        "createdByHsaId": { "type": "string", "required": false },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "realname": { "type": "string", "required": false },
        "email": { "type": "string", "required": false },
        "hsaId": { "type": "string", "required": false },
        "creationTime": { "type": "string", "format": "date-time", "required": false },
        "updatedTime": { "type": "string", "format": "date-time", "required": false },
        "lastLogin": { "type": "string", "format": "date-time", "required": false },
        "careUnits": { "$ref": "careUnitReferenceList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "careUnits": [],
  "createdByHsaId": "",
  "creationTime": 1391636105000,
  "email": "",
  "hsaId": "super",
  "lastLogin": 1428666138000,
  "realname": "super",
  "role": "SUPERADMIN",
  "sourceSystemHsaId": "",
  "status": "ACTIVE",
  "updatedTime": 1391636105000
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users__hsaId__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/users</span>/{hsaId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update the information for a specific user.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users__hsaId__put_request" data-toggle="tab">Request</a></li><li><a href="#_users__hsaId__put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users__hsaId__put_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the User</strong>: <em>required (string )</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A User creation or update request",
    "properties": {
        "status": { "type": "string", "required": true },
        "hsaId": { "type": "string", "required": true, "minLength": 1 },
        "realname": { "type": "string", "required": true },
        "email": { "type": "string", "required": true, "minLength": 1 },
        "hsaID": { "type": "string", "required": false },
        "password": { "type": "string", "minLength": 8 },
        "role": { "type": "string", "required": false },
        "careUnitID": { "$ref": "careUnitReferenceList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "status": "OPEN",
  "hsaId": "SE2321000016-FHR3",
  "realname": "Bosse Bäckström",
  "email": "bosse.backstrom@bockling.nu",
  "hsaID": "SE2321000016-FHR3",
  "password": "********",
  "role": "Vaktmästare",
  "careUnitID":
  [
    {
      "hsaId": "SE2321000016-45FD",
      "displayName": "Enhet X"
    }
  ]
}
</code></pre></div><div class="tab-pane" id="_users__hsaId__put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The user was updated and the new User object is returned in the Body</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A single User",
    "properties": {
        "status": { "type": "string", "required": false },
        "role": { "type": "string", "required": false },
        "createdByHsaId": { "type": "string", "required": false },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "realname": { "type": "string", "required": false },
        "email": { "type": "string", "required": false },
        "hsaId": { "type": "string", "required": false },
        "creationTime": { "type": "string", "format": "date-time", "required": false },
        "updatedTime": { "type": "string", "format": "date-time", "required": false },
        "lastLogin": { "type": "string", "format": "date-time", "required": false },
        "careUnits": { "$ref": "careUnitReferenceList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "careUnits": [],
  "createdByHsaId": "",
  "creationTime": 1391636105000,
  "email": "",
  "hsaId": "super",
  "lastLogin": 1428666138000,
  "realname": "super",
  "role": "SUPERADMIN",
  "sourceSystemHsaId": "",
  "status": "ACTIVE",
  "updatedTime": 1391636105000
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users__hsaId__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/users</span>/{hsaId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete an offer</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users__hsaId__delete_request" data-toggle="tab">Request</a></li><li><a href="#_users__hsaId__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users__hsaId__delete_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the User</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_users__hsaId__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>Offer was deleted successfully (no content in response body)</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users__hsaId__role__role_"><span class="parent">/users/{hsaId}</span>/role/{role}</a> <span class="methods"><a href="#_users__hsaId__role__role__put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel__users__hsaId__role__role_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users__hsaId__role__role__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Updates the role for a specific user</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users__hsaId__role__role__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/users/{hsaId}</span>/role/{role}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Updates the role for a specific user</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users__hsaId__role__role__put_request" data-toggle="tab">Request</a></li><li><a href="#_users__hsaId__role__role__put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users__hsaId__role__role__put_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the User</strong>: <em>required (string )</em></li><li><strong>The name of the user role</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_users__hsaId__role__role__put_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>The Role was updated. No content in response.</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users_units__unitId_"><span class="parent">/users</span>/units/{unitId}</a> <span class="methods"><a href="#_users_units__unitId__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__users_units__unitId_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users_units__unitId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all users for the given unit</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users_units__unitId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/users</span>/units/{unitId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all users for the given unit</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users_units__unitId__get_request" data-toggle="tab">Request</a></li><li><a href="#_users_units__unitId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users_units__unitId__get_request"><h3>URI Parameters</h3><ul><li><strong>The unit id</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_users_units__unitId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The user information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of Users",
  "items": { "$ref": "user" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>[
  {
    "careUnits": [],
    "createdByHsaId": "",
    "creationTime": 1391636105000,
    "email": "",
    "hsaId": "super",
    "lastLogin": 1428666138000,
    "realname": "super",
    "role": "SUPERADMIN",
    "sourceSystemHsaId": "",
    "status": "ACTIVE",
    "updatedTime": 1391636105000
  },
  {
    "careUnits": [],
    "createdByHsaId": "",
    "creationTime": 1399452714000,
    "email": "ca@sll.se",
    "hsaId": "ca",
    "lastLogin": null,
    "realname": "Capacity Admin",
    "role": "CAPACITYADMIN",
    "sourceSystemHsaId": "",
    "status": "ACTIVE",
    "updatedTime": 1399452714000
  }
]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users_units_setusers"><span class="parent">/users</span>/units/setusers</a> <span class="methods"><a href="#_users_units_setusers_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel__users_units_setusers" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users_units_setusers_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets user for the specified unit.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users_units_setusers_put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/users</span>/units/setusers</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets user for the specified unit.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users_units_setusers_put_request" data-toggle="tab">Request</a></li><li><a href="#_users_units_setusers_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users_units_setusers_put_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A request to add the specified user to the specified care unit",
    "properties": {
        "unitId": { "type": "string", "required": true },
        "hsaId": { "type": "array", "required": true, "items": { "type" : "string" } }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "unitId": "1111AFAF1",
  "hsaId": "SE2321000016-TDDR"
}
</code></pre></div><div class="tab-pane" id="_users_units_setusers_put_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>The user information was successfully updated.</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__users_emails"><span class="parent">/users</span>/emails</a> <span class="methods"><a href="#_users_emails_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__users_emails" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_users_emails_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Finds email addresses for administrators for the given units. This method will return emails for users with roles CAREUNITADMIN and CAPACITYADMIN.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_users_emails_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/users</span>/emails</h4></div><div class="modal-body"><div class="alert alert-info"><p>Finds email addresses for administrators for the given units. This method will return emails for users with roles CAREUNITADMIN and CAPACITYADMIN.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_users_emails_post_request" data-toggle="tab">Request</a></li><li><a href="#_users_emails_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_users_emails_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of Users",
  "items": { "type": "string"}
}
</code></pre><p><strong>Example</strong>:</p><pre><code>[
  "Unit 1",
  "Unit 2"
]
</code></pre></div><div class="tab-pane" id="_users_emails_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of Users",
  "items": { "type": "string"}
}
</code></pre><p><strong>Example</strong>:</p><pre><code>[
  "bosse.backstrom@bockling.nu",
  "adam.andersson@amail.as"
]</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#_aggregated">AggregatedService</a></li><li><a href="#_monitor">MonitorService</a></li><li><a href="#_roles">RolesService</a></li><li><a href="#_users">UsersService</a></li></ul></div></div></div></div></body></html>